<HTML>
<BODY BGCOLOR="white">
<PRE>
<FONT color="green">001</FONT>    package metaface.client;<a name="line.1"></a>
<FONT color="green">002</FONT>    import javax.xml.parsers.*;<a name="line.2"></a>
<FONT color="green">003</FONT>    import org.xml.sax.*;<a name="line.3"></a>
<FONT color="green">004</FONT>    import org.xml.sax.helpers.*;<a name="line.4"></a>
<FONT color="green">005</FONT>    import java.util.*;<a name="line.5"></a>
<FONT color="green">006</FONT>    import java.io.*;<a name="line.6"></a>
<FONT color="green">007</FONT>    import metaface.mpeg4.*;<a name="line.7"></a>
<FONT color="green">008</FONT>    <a name="line.8"></a>
<FONT color="green">009</FONT>    /**<a name="line.9"></a>
<FONT color="green">010</FONT>     *  This class is used to read pre-rendered Facial Animation Parameters (FAPs),<a name="line.10"></a>
<FONT color="green">011</FONT>     *  phonemes, Uniform Resource Locators (URLs) and text from an eXtensible<a name="line.11"></a>
<FONT color="green">012</FONT>     *  Markup Language (XML) file. &lt;p><a name="line.12"></a>
<FONT color="green">013</FONT>     *<a name="line.13"></a>
<FONT color="green">014</FONT>     *  These files are formed during presynthesis of Virtual Human Markup Language<a name="line.14"></a>
<FONT color="green">015</FONT>     *  (VHML) XML documents&lt;p><a name="line.15"></a>
<FONT color="green">016</FONT>     *<a name="line.16"></a>
<FONT color="green">017</FONT>     *  These files are in the form of: &lt;BR/><a name="line.17"></a>
<FONT color="green">018</FONT>     *  &lt;code><a name="line.18"></a>
<FONT color="green">019</FONT>     * &lt;eca_synthesis&gt;&lt;br/><a name="line.19"></a>
<FONT color="green">020</FONT>     *  &nbsp;&nbsp;&lt;text&gt;the text spoken by the ECA&lt;/text&gt;&lt;br/><a name="line.20"></a>
<FONT color="green">021</FONT>     *  &nbsp;&nbsp;&lt;url target="name.of.browser.frame"&gt;http://some.url.here&lt;/url&gt;<a name="line.21"></a>
<FONT color="green">022</FONT>     *  &lt;br/><a name="line.22"></a>
<FONT color="green">023</FONT>     *  &nbsp;&nbsp;&lt;url target="another.browser.frame"&gt;http://another.url.here&lt;/url&gt;<a name="line.23"></a>
<FONT color="green">024</FONT>     *  &lt;br/><a name="line.24"></a>
<FONT color="green">025</FONT>     *  &nbsp;&nbsp;....&lt;br/><a name="line.25"></a>
<FONT color="green">026</FONT>     *  &nbsp;&nbsp;&lt;phonemes&gt;&lt;br/><a name="line.26"></a>
<FONT color="green">027</FONT>     *  &nbsp;&nbsp;&nbsp;&nbsp;A list of the ECA phonemes for speech&lt;br/><a name="line.27"></a>
<FONT color="green">028</FONT>     *  &nbsp;&nbsp;&lt;phonemes&gt;&lt;br/><a name="line.28"></a>
<FONT color="green">029</FONT>     *  &nbsp;&nbsp;&lt;faps&gt;&lt;br/><a name="line.29"></a>
<FONT color="green">030</FONT>     *  &nbsp;&nbsp;&nbsp;&nbsp;A list of the MPEG-4 FAPs for facial animation&lt;br/><a name="line.30"></a>
<FONT color="green">031</FONT>     *  &nbsp;&nbsp;&lt;faps&gt;&lt;br/><a name="line.31"></a>
<FONT color="green">032</FONT>     *  &lt;/eca_synthesis&gt;&lt;br/><a name="line.32"></a>
<FONT color="green">033</FONT>     *  &lt;/code>&lt;p><a name="line.33"></a>
<FONT color="green">034</FONT>     *<a name="line.34"></a>
<FONT color="green">035</FONT>     *  Follow this link to retrieve the Document Type Definition <a name="line.35"></a>
<FONT color="green">036</FONT>     *  &lt;A HREF="../../resources/vhml_output.dtd">vhml_output.dtd&lt;/A> Follow this link<a name="line.36"></a>
<FONT color="green">037</FONT>     *  to retrieve an example XML file &lt;A HREF="../../resources/vhml_output.xml"><a name="line.37"></a>
<FONT color="green">038</FONT>     *  vhml_example.xml&lt;/A><a name="line.38"></a>
<FONT color="green">039</FONT>     *<a name="line.39"></a>
<FONT color="green">040</FONT>     *@author     Simon Beard<a name="line.40"></a>
<FONT color="green">041</FONT>     *<a name="line.41"></a>
<FONT color="green">042</FONT>     *@version    1.0<a name="line.42"></a>
<FONT color="green">043</FONT>     *@see        VHMLOutputReader<a name="line.43"></a>
<FONT color="green">044</FONT>     *@see        metaface.presynthesise.PreSynthesise<a name="line.44"></a>
<FONT color="green">045</FONT>     */<a name="line.45"></a>
<FONT color="green">046</FONT>    class VHMLOutputTagReader extends DefaultHandler {<a name="line.46"></a>
<FONT color="green">047</FONT>    <a name="line.47"></a>
<FONT color="green">048</FONT>            /**<a name="line.48"></a>
<FONT color="green">049</FONT>             *  hold characters read within the XML document<a name="line.49"></a>
<FONT color="green">050</FONT>             */<a name="line.50"></a>
<FONT color="green">051</FONT>            private String tempchar = "";<a name="line.51"></a>
<FONT color="green">052</FONT>            /**<a name="line.52"></a>
<FONT color="green">053</FONT>             *  remember the last target frame for the URL<a name="line.53"></a>
<FONT color="green">054</FONT>             */<a name="line.54"></a>
<FONT color="green">055</FONT>            private String target = "";<a name="line.55"></a>
<FONT color="green">056</FONT>            /**<a name="line.56"></a>
<FONT color="green">057</FONT>             *  hold the ECA phonemes<a name="line.57"></a>
<FONT color="green">058</FONT>             */<a name="line.58"></a>
<FONT color="green">059</FONT>            private Vector phonemes;<a name="line.59"></a>
<FONT color="green">060</FONT>            /**<a name="line.60"></a>
<FONT color="green">061</FONT>             *  hold the ECA MPEG-4 FAPs<a name="line.61"></a>
<FONT color="green">062</FONT>             */<a name="line.62"></a>
<FONT color="green">063</FONT>            private Vector faps;<a name="line.63"></a>
<FONT color="green">064</FONT>            /**<a name="line.64"></a>
<FONT color="green">065</FONT>             *  hold the plain text spoken by the ECA<a name="line.65"></a>
<FONT color="green">066</FONT>             */<a name="line.66"></a>
<FONT color="green">067</FONT>            private String text;<a name="line.67"></a>
<FONT color="green">068</FONT>            /**<a name="line.68"></a>
<FONT color="green">069</FONT>             *  hold a table of URLs by their target keys<a name="line.69"></a>
<FONT color="green">070</FONT>             */<a name="line.70"></a>
<FONT color="green">071</FONT>            private Hashtable browserupdates;<a name="line.71"></a>
<FONT color="green">072</FONT>    <a name="line.72"></a>
<FONT color="green">073</FONT>    <a name="line.73"></a>
<FONT color="green">074</FONT>            /**<a name="line.74"></a>
<FONT color="green">075</FONT>             *  The constructor that intitialises the output reader<a name="line.75"></a>
<FONT color="green">076</FONT>             */<a name="line.76"></a>
<FONT color="green">077</FONT>            public VHMLOutputTagReader() {<a name="line.77"></a>
<FONT color="green">078</FONT>                    super();<a name="line.78"></a>
<FONT color="green">079</FONT>                    phonemes = new Vector();<a name="line.79"></a>
<FONT color="green">080</FONT>                    faps = new Vector();<a name="line.80"></a>
<FONT color="green">081</FONT>                    text = "";<a name="line.81"></a>
<FONT color="green">082</FONT>                    browserupdates = new Hashtable();<a name="line.82"></a>
<FONT color="green">083</FONT>            }<a name="line.83"></a>
<FONT color="green">084</FONT>    <a name="line.84"></a>
<FONT color="green">085</FONT>    <a name="line.85"></a>
<FONT color="green">086</FONT>            /**<a name="line.86"></a>
<FONT color="green">087</FONT>             *  Allows access to the MPEG-4 FAPs retrieved<a name="line.87"></a>
<FONT color="green">088</FONT>             *<a name="line.88"></a>
<FONT color="green">089</FONT>             *@return    A list of FAPData MPEG-4 FAP frames<a name="line.89"></a>
<FONT color="green">090</FONT>             */<a name="line.90"></a>
<FONT color="green">091</FONT>            public Vector getFrames() {<a name="line.91"></a>
<FONT color="green">092</FONT>                    return (faps);<a name="line.92"></a>
<FONT color="green">093</FONT>            }<a name="line.93"></a>
<FONT color="green">094</FONT>    <a name="line.94"></a>
<FONT color="green">095</FONT>    <a name="line.95"></a>
<FONT color="green">096</FONT>            /**<a name="line.96"></a>
<FONT color="green">097</FONT>             *  Allows access to the phonemes retrieved<a name="line.97"></a>
<FONT color="green">098</FONT>             *<a name="line.98"></a>
<FONT color="green">099</FONT>             *@return    A list of phonemes<a name="line.99"></a>
<FONT color="green">100</FONT>             */<a name="line.100"></a>
<FONT color="green">101</FONT>            public Vector getPhonemes() {<a name="line.101"></a>
<FONT color="green">102</FONT>                    return (phonemes);<a name="line.102"></a>
<FONT color="green">103</FONT>            }<a name="line.103"></a>
<FONT color="green">104</FONT>    <a name="line.104"></a>
<FONT color="green">105</FONT>    <a name="line.105"></a>
<FONT color="green">106</FONT>            /**<a name="line.106"></a>
<FONT color="green">107</FONT>             *  Allows access to the plain text retrieved<a name="line.107"></a>
<FONT color="green">108</FONT>             *<a name="line.108"></a>
<FONT color="green">109</FONT>             *@return    A String of characters<a name="line.109"></a>
<FONT color="green">110</FONT>             */<a name="line.110"></a>
<FONT color="green">111</FONT>            public String getText() {<a name="line.111"></a>
<FONT color="green">112</FONT>                    return (text);<a name="line.112"></a>
<FONT color="green">113</FONT>            }<a name="line.113"></a>
<FONT color="green">114</FONT>    <a name="line.114"></a>
<FONT color="green">115</FONT>    <a name="line.115"></a>
<FONT color="green">116</FONT>            /**<a name="line.116"></a>
<FONT color="green">117</FONT>             *  Allows access to the URLs and targets retrieved<a name="line.117"></a>
<FONT color="green">118</FONT>             *<a name="line.118"></a>
<FONT color="green">119</FONT>             *@return    A table of URLs referenced by their targets as keys<a name="line.119"></a>
<FONT color="green">120</FONT>             */<a name="line.120"></a>
<FONT color="green">121</FONT>            public Hashtable getBrowserUpdates() {<a name="line.121"></a>
<FONT color="green">122</FONT>                    return (browserupdates);<a name="line.122"></a>
<FONT color="green">123</FONT>            }<a name="line.123"></a>
<FONT color="green">124</FONT>    <a name="line.124"></a>
<FONT color="green">125</FONT>    <a name="line.125"></a>
<FONT color="green">126</FONT>            /**<a name="line.126"></a>
<FONT color="green">127</FONT>             *  The parser calls this once at the beginning of a document<a name="line.127"></a>
<FONT color="green">128</FONT>             *<a name="line.128"></a>
<FONT color="green">129</FONT>             *@exception  SAXException  XML parsing Exception        <a name="line.129"></a>
<FONT color="green">130</FONT>             */<a name="line.130"></a>
<FONT color="green">131</FONT>            public void startDocument() throws SAXException {<a name="line.131"></a>
<FONT color="green">132</FONT>            }<a name="line.132"></a>
<FONT color="green">133</FONT>    <a name="line.133"></a>
<FONT color="green">134</FONT>    <a name="line.134"></a>
<FONT color="green">135</FONT>            /**<a name="line.135"></a>
<FONT color="green">136</FONT>             *  The parser calls this once after parsing a document<a name="line.136"></a>
<FONT color="green">137</FONT>             *<a name="line.137"></a>
<FONT color="green">138</FONT>             *@exception  SAXException  XML parsing Exception        <a name="line.138"></a>
<FONT color="green">139</FONT>             */<a name="line.139"></a>
<FONT color="green">140</FONT>            public void endDocument() throws SAXException {<a name="line.140"></a>
<FONT color="green">141</FONT>            }<a name="line.141"></a>
<FONT color="green">142</FONT>    <a name="line.142"></a>
<FONT color="green">143</FONT>    <a name="line.143"></a>
<FONT color="green">144</FONT>            /**<a name="line.144"></a>
<FONT color="green">145</FONT>             *  The parser calls this when encountering character data<a name="line.145"></a>
<FONT color="green">146</FONT>             *<a name="line.146"></a>
<FONT color="green">147</FONT>             *@param  ch                the characers encountered between tags<a name="line.147"></a>
<FONT color="green">148</FONT>             *@param  start             the starting point in the character array<a name="line.148"></a>
<FONT color="green">149</FONT>             *@param  length            the length of character data occupying the array<a name="line.149"></a>
<FONT color="green">150</FONT>             *@exception  SAXException  XML parsing Exception        <a name="line.150"></a>
<FONT color="green">151</FONT>             */<a name="line.151"></a>
<FONT color="green">152</FONT>            public void characters(char[] ch, int start, int length) throws SAXException {<a name="line.152"></a>
<FONT color="green">153</FONT>                    //Store the character data as encountered between tags<a name="line.153"></a>
<FONT color="green">154</FONT>                    tempchar = tempchar.concat(new String(ch, start, length));<a name="line.154"></a>
<FONT color="green">155</FONT>            }<a name="line.155"></a>
<FONT color="green">156</FONT>    <a name="line.156"></a>
<FONT color="green">157</FONT>    <a name="line.157"></a>
<FONT color="green">158</FONT>            /**<a name="line.158"></a>
<FONT color="green">159</FONT>             *  The parser calls this for each element in a document<a name="line.159"></a>
<FONT color="green">160</FONT>             *<a name="line.160"></a>
<FONT color="green">161</FONT>             *@param  namespaceURI      used to resolve the namespace of the element<a name="line.161"></a>
<FONT color="green">162</FONT>             *@param  localName         the local name of the element<a name="line.162"></a>
<FONT color="green">163</FONT>             *@param  rawName           the resolved name of the element<a name="line.163"></a>
<FONT color="green">164</FONT>             *@param  atts              the attributes of the element<a name="line.164"></a>
<FONT color="green">165</FONT>             *@exception  SAXException  XML parsing Exception        <a name="line.165"></a>
<FONT color="green">166</FONT>             */<a name="line.166"></a>
<FONT color="green">167</FONT>            public void startElement(String namespaceURI, String localName, String rawName, Attributes atts) throws SAXException {<a name="line.167"></a>
<FONT color="green">168</FONT>                    //Get the key and determine what tag has been encountered<a name="line.168"></a>
<FONT color="green">169</FONT>                    String key = rawName;<a name="line.169"></a>
<FONT color="green">170</FONT>                    if (key.compareTo("eca_synthesis") == 0) {<a name="line.170"></a>
<FONT color="green">171</FONT>                    } else if (key.compareTo("text") == 0) {<a name="line.171"></a>
<FONT color="green">172</FONT>                            //Reset character string<a name="line.172"></a>
<FONT color="green">173</FONT>                            tempchar = "";<a name="line.173"></a>
<FONT color="green">174</FONT>                    } else if (key.compareTo("url") == 0) {<a name="line.174"></a>
<FONT color="green">175</FONT>                            //Store the target<a name="line.175"></a>
<FONT color="green">176</FONT>                            target = atts.getValue(0);<a name="line.176"></a>
<FONT color="green">177</FONT>                            tempchar = "";<a name="line.177"></a>
<FONT color="green">178</FONT>                    } else if (key.compareTo("phonemes") == 0) {<a name="line.178"></a>
<FONT color="green">179</FONT>                            tempchar = "";<a name="line.179"></a>
<FONT color="green">180</FONT>                    } else if (key.compareTo("faps") == 0) {<a name="line.180"></a>
<FONT color="green">181</FONT>                            tempchar = "";<a name="line.181"></a>
<FONT color="green">182</FONT>                    }<a name="line.182"></a>
<FONT color="green">183</FONT>            }<a name="line.183"></a>
<FONT color="green">184</FONT>    <a name="line.184"></a>
<FONT color="green">185</FONT>    <a name="line.185"></a>
<FONT color="green">186</FONT>            /**<a name="line.186"></a>
<FONT color="green">187</FONT>             *  The parser calls this when encountering a closing tag.<a name="line.187"></a>
<FONT color="green">188</FONT>             *<a name="line.188"></a>
<FONT color="green">189</FONT>             *@param  namespaceURI  used to resolve the namespace of the element<a name="line.189"></a>
<FONT color="green">190</FONT>             *@param  localName     the local name of the element<a name="line.190"></a>
<FONT color="green">191</FONT>             *@param  rawName       the resolved name of the element         <a name="line.191"></a>
<FONT color="green">192</FONT>             */<a name="line.192"></a>
<FONT color="green">193</FONT>            public void endElement(String namespaceURI, String localName, String rawName) {<a name="line.193"></a>
<FONT color="green">194</FONT>                    //Get the key and determine what tag has been encountered<a name="line.194"></a>
<FONT color="green">195</FONT>                    String key = rawName;<a name="line.195"></a>
<FONT color="green">196</FONT>                    if (key.compareTo("eca_synthesis") == 0) {<a name="line.196"></a>
<FONT color="green">197</FONT>                    } else if (key.compareTo("text") == 0) {<a name="line.197"></a>
<FONT color="green">198</FONT>                            //Get rid of white space<a name="line.198"></a>
<FONT color="green">199</FONT>                            text = tempchar.trim();<a name="line.199"></a>
<FONT color="green">200</FONT>                    } else if (key.compareTo("url") == 0) {<a name="line.200"></a>
<FONT color="green">201</FONT>                            //Store the URL using its target as the key<a name="line.201"></a>
<FONT color="green">202</FONT>                            browserupdates.put(target, tempchar.trim());<a name="line.202"></a>
<FONT color="green">203</FONT>                    } else if (key.compareTo("phonemes") == 0) {<a name="line.203"></a>
<FONT color="green">204</FONT>                            int i;<a name="line.204"></a>
<FONT color="green">205</FONT>                            int j;<a name="line.205"></a>
<FONT color="green">206</FONT>                            String line;<a name="line.206"></a>
<FONT color="green">207</FONT>    <a name="line.207"></a>
<FONT color="green">208</FONT>                            //Parse the phonemes line by line to store in a list rather than as a string<a name="line.208"></a>
<FONT color="green">209</FONT>                            tempchar = tempchar.trim();<a name="line.209"></a>
<FONT color="green">210</FONT>                            i = tempchar.indexOf('\n');<a name="line.210"></a>
<FONT color="green">211</FONT>                            j = 0;<a name="line.211"></a>
<FONT color="green">212</FONT>                            while (i > 0) {<a name="line.212"></a>
<FONT color="green">213</FONT>                                    line = tempchar.substring(j, i);<a name="line.213"></a>
<FONT color="green">214</FONT>                                    phonemes.add(line);<a name="line.214"></a>
<FONT color="green">215</FONT>                                    i++;<a name="line.215"></a>
<FONT color="green">216</FONT>                                    j = i;<a name="line.216"></a>
<FONT color="green">217</FONT>                                    i = tempchar.indexOf('\n', j);<a name="line.217"></a>
<FONT color="green">218</FONT>                            }<a name="line.218"></a>
<FONT color="green">219</FONT>                            line = tempchar.substring(j, tempchar.length());<a name="line.219"></a>
<FONT color="green">220</FONT>                            phonemes.add(line);<a name="line.220"></a>
<FONT color="green">221</FONT>                    } else if (key.compareTo("faps") == 0) {<a name="line.221"></a>
<FONT color="green">222</FONT>                            int i;<a name="line.222"></a>
<FONT color="green">223</FONT>                            int j;<a name="line.223"></a>
<FONT color="green">224</FONT>                            String mask;<a name="line.224"></a>
<FONT color="green">225</FONT>                            String values;<a name="line.225"></a>
<FONT color="green">226</FONT>    <a name="line.226"></a>
<FONT color="green">227</FONT>                            //Parse FAP bitmasks and values string to store as FAPData objects in a list<a name="line.227"></a>
<FONT color="green">228</FONT>                            tempchar = tempchar.trim();<a name="line.228"></a>
<FONT color="green">229</FONT>                            i = tempchar.indexOf('\n');<a name="line.229"></a>
<FONT color="green">230</FONT>                            j = 0;<a name="line.230"></a>
<FONT color="green">231</FONT>                            while (i > 0) {<a name="line.231"></a>
<FONT color="green">232</FONT>                                    mask = tempchar.substring(j, i);<a name="line.232"></a>
<FONT color="green">233</FONT>                                    i++;<a name="line.233"></a>
<FONT color="green">234</FONT>                                    j = i;<a name="line.234"></a>
<FONT color="green">235</FONT>                                    i = tempchar.indexOf('\n', j);<a name="line.235"></a>
<FONT color="green">236</FONT>                                    if (i &lt; 0) {<a name="line.236"></a>
<FONT color="green">237</FONT>                                            i = tempchar.length();<a name="line.237"></a>
<FONT color="green">238</FONT>                                    }<a name="line.238"></a>
<FONT color="green">239</FONT>                                    values = tempchar.substring(j, i);<a name="line.239"></a>
<FONT color="green">240</FONT>                                    faps.add(new FAPData(mask, values));<a name="line.240"></a>
<FONT color="green">241</FONT>                                    i++;<a name="line.241"></a>
<FONT color="green">242</FONT>                                    j = i;<a name="line.242"></a>
<FONT color="green">243</FONT>                                    i = tempchar.indexOf('\n', j);<a name="line.243"></a>
<FONT color="green">244</FONT>                            }<a name="line.244"></a>
<FONT color="green">245</FONT>                    }<a name="line.245"></a>
<FONT color="green">246</FONT>            }<a name="line.246"></a>
<FONT color="green">247</FONT>    }<a name="line.247"></a>




























































</PRE>
</BODY>
</HTML>
